GemaCoreLib
The GeMA Core library
Loading...
Searching...
No Matches
gmPrintUtils.h File Reference

Utilitary functions for printing data. More...

#include "gmLog.h"
Include dependency graph for gmPrintUtils.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  GmPrintUtils
 Groups utilitary routines for pretty printing data. More...
 

Enumerations

enum  GmPrintUtilsFlags {
  GM_PRINT_UNITS = 0x000001 , GM_PRINT_UNITS_ON_SECOND_LINE = 0x000002 , GM_PRINT_EVAL_FUNCTIONS = 0x000004 , GM_PRINT_DEF_AS_NIL = 0x000008 ,
  GM_PRINT_LINE_NUMBERS = 0x000010 , GM_PRINT_CLIP_TITLES = 0x000020 , GM_PRINT_CELL_TYPE = 0x000040 , GM_PRINT_CELL_NODES = 0x000080 ,
  GM_PRINT_CELL_PROPERTY_NAMES = 0x000100 , GM_PRINT_CELL_EVAL_POINT = 0x000200 , GM_PRINT_CELL_ACTIVE = 0x000400 , GM_PRINT_NODE_GEOMETRY = 0x000800 ,
  GM_PRINT_NODE_GHOST = 0x001000 , GM_PRINT_MARK_GHOST_NODES = 0x002000 , GM_PRINT_HEADER_TITLE = 0x004000 , GM_PRINT_TRAILLER = 0x008000 ,
  GM_PRINT_ACTIVEONLY = 0x010000 , GM_PRINT_CONSTMAP = 0x020000 , GM_PRINT_ID = 0x040000 , GM_PRINT_INTERNAL_ID = 0x080000 ,
  GM_PRINT_INTERNAL_ORDER = 0x100000 , GM_PRINT_USER = 0x200000 , GM_PRINT_DEFAULT
}
 Set of combinable options controlling the behaviour of print functions. More...
 

Detailed Description

Utilitary functions for printing data.

Author
Carlos Augusto Teixeira Mendes
Date
august, 2015

Enumeration Type Documentation

◆ GmPrintUtilsFlags

Set of combinable options controlling the behaviour of print functions.

Enumerator
GM_PRINT_UNITS 

Should we print units in column title? Default = true.

GM_PRINT_UNITS_ON_SECOND_LINE 

Should we print units in the header in a separate line? Default = false.

GM_PRINT_EVAL_FUNCTIONS 

Should we evaluate functions or do we print its name? Default = false.

GM_PRINT_DEF_AS_NIL 

Should we print default values as 'nil'? Default = false.

GM_PRINT_LINE_NUMBERS 

Should we print line numbers on the left margin? Default = true.

GM_PRINT_CLIP_TITLES 

Should we clip column titles when the user gave us a width and the title is bigger than that? Default = true.

GM_PRINT_CELL_TYPE 

Should we add a type column for cell meshes / Gauss attributes? Default = true.

GM_PRINT_CELL_NODES 

Should we add a node column for cell meshes? Default = true.

GM_PRINT_CELL_PROPERTY_NAMES 

Should we add a columns with property names for cell meshes? Default = true.

GM_PRINT_CELL_EVAL_POINT 

Should we add a evaluation point column when EVAL_FUNCTIONS = true for cell meshes or for Gauss Attributes? Default = false.

GM_PRINT_CELL_ACTIVE 

Should we add a column telling if the cell is active or not for cell meshes? Default = false.

GM_PRINT_NODE_GEOMETRY 

Should we print common geometry nodes? When false, filters rows in printValueTable() or cell nodes in printCellTable(). Default = true.

GM_PRINT_NODE_GHOST 

Should we print ghost nodes? When false, filters rows in printValueTable() or cell nodes in printCellTable(). Default = true.

GM_PRINT_MARK_GHOST_NODES 

Should we mark line numbers (with a '|' prefix) in printValueTable() or cell node numbers in printCellTable()? Default = false.

GM_PRINT_HEADER_TITLE 

Should we print a title in the header, for the entire table? Default = false.

GM_PRINT_TRAILLER 

Should we add a closing trailler line to the table? Default = false.

GM_PRINT_ACTIVEONLY 

Should we print only active cells? Default = true.

GM_PRINT_CONSTMAP 

Should we try to translate values back to strings when a scalar data column has an associated const map? Default = false.

GM_PRINT_ID 

Should we add a node or cell Ids column? For node ids, ghost nodes are represented as negative numbers. For compatibility, it is used only if the mesh was partitioned or if INTERNAL_ORDER is true. Default = true.

GM_PRINT_INTERNAL_ID 

Should we add an internal (renumbered but 1-based) node/cell id column? For node ids, ghost nodes are represented as negative numbers. Default = false.

GM_PRINT_INTERNAL_ORDER 

Should we order the rows in the table according to the internal id (instead of the model id)? Default = false.

GM_PRINT_USER 

A mark to set the first 'user' option available. This value should be updated whenever adding options to GmPrintUtilsFlags.

GM_PRINT_DEFAULT 

A tag to request that the options should be filled with the default.